NHS 111
Domain Message Specification

RepeatCallerResponse Tabular View

PRPA_RM000001GB01
RepeatCallerResponse
This message is a response to the Repeat Caller Service Query to ascertain whether the NHS111 patient is a repeat caller to the NHS111 service.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }
Model Attribute Description

The HL7 attribute classCode describes this class as an observation.

Implementation in XML Instance


The XML attribute classCode is fixed to " OBS ".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode describes this class as an event.

Implementation in XML Instance


The XML attribute moodCode is fixed to " EVN ".
[1..1] [M] code (CV { CNE:NHS111MessageType } )
{ Fixed="02" }
Model Attribute Description

The HL7 attribute code uses a code from the NHS111MessageType vocabulary to describe this message as a Repeat Caller response message.

Implementation in XML Instance


The Coded with Code System flavour of Coded Value (CV) data type shall be used to carry this in the XML element code as follows:
  • The XML attribute code shall contain " 02 "
  • The XML attribute codeSystem shall contain the OID " 2.16.840.1.113883.2.1.3.2.4.17.420 "
[1..1] [M] effectiveTime (TS)
Model Attribute Description

The HL7 attribute effectiveTime is used to define when the response from the repeat caller service was made.

Implementation in XML Instance


The XML attribute value of the XML element effectiveTime shall be populated with the time the response from the repeat caller service was made using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes
[1..1] [M] id (II)
Model Attribute Description

The HL7 attribute id holds a unique identifier for this repeat caller response event.

Implementation in XML Instance

The XML element id is populated with a generated DCE UUID in the following way:
  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] value (CV { CNE:NHS111RepeatCallerServiceResponseType } )

Model Attribute Description

The HL7 attribute value uses a code from the NHS111RepeatCallerServiceResponseType vocabulary to describe the response of the repeat caller service to a query.

Implementation in XML Instance

The Coded Plain flavour of Coded Value (CV) data type shall be used to carry this in the XML element value as follows:

  • The XML attribute code shall contain a code from the RepeatCallerResponseType vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.421"
  • The XML attribute displayName shall contain the display text associated with the code

[1..1] [M] author
This class links the repeat caller service query to author of the query.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an author participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " AUT ".

[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description
The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the query are conducted across to the child classes (also associated with the child classes). This set of codes also determines how these participations conduct.

The conduction can only take place if the contextConductionInd is set to " true "

The value of this attribute is fixed in the HL7 model to " OP "

  • " O " (Overriding)- the author replaces any author that has been conducted from any previous acts.
  • " P " (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to " true ".

Implementation in XML Instance
The XML attribute contextControlCode is fixed to " OP "

[1..1] [M] contentId (II) { "NPFIT-100034#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance


The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID " 2.16.840.1.113883.2.1.3.2.4.18.16 "
  • The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] participant (AuthorChoice)
A link to a choice of authors.
[0..1] pertinentInformation

This class is a relationship of pertinent information.

It is used to carry the Permission To View outcome.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="PERT" }

Model Attribute Description

The HL7 attribute typeCode describes this class as one of pertinent information.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "PERT".
[1..1] [M] contentId (II) { "NPFIT-300007#Act" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] pertinentPermissionToViewChoice (PermissionToViewChoice)
A link to the choice of permission to view templates.
[1..1] [M] primaryInformationRecipient
This class is a primary information recipient participation.

The primary information recipient of the Repeat Caller Service response.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="PRCP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a primary informant participation.

Implementation in XML Instance

The XML attribute typeCode is fixed to " PRCP ".

[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the response are conducted across to the child classes (also associated with the child classes). This set of codes also determines how these participations conduct.

The conduction can only take place if the contextConductionInd is set to " true "

The value of this attribute is fixed in the HL7 model to " OP "

  • " O " (Overriding)- the author replaces any author that has been conducted from any previous acts.
  • " P " (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to " true ".

Implementation in XML Instance

The XML attribute contextControlCode is fixed to " OP "

[1..1] [M] contentId (II) { "NPFIT-100032#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance


The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID " 2.16.840.1.113883.2.1.3.2.4.18.16 "
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (RecipientChoice)
A link to a choice of participants.
[1..1] [M] reference
Details of the query id that generated this response.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="REFR" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a reference.

Implementation in XML Instance

The XML attribute typeCode is fixed to " REFR".

[1..1] [M] contextConductionInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to " true ".

The value of this attribute is fixed in the HL7 model to " OP ":

  • " O " (Overriding)- the author replaces any author that has been conducted from any previous acts.
  • " P " (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to " true ".

Implementation in XML Instance

The XML attribute contextControlCode shall contain the fixed value " OP ".

[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

This attribute is used to indicate that response information must not be separated from the outcome.

Implementation in XML Instance

The XML attribute seperatableInd is fixed to " false ".

[1..1] [M] referredToRequest (Request)
A link to the query identifier.
[0..*] subject
Details of the NHS111 reports that are returned to the requestor if the subject of the NHS111 call is deemed to be a repeat caller.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="SUBJ" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a subject.

Implementation in XML Instance

The XML attribute typeCode is fixed to " SUBJ ".

[1..1] [M] contextConductionInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute contextConductionId is used to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section).

The conduction can only take place if the contextConductionInd is set to " true ".

Implementation in XML Instance

The XML attribute contextControlInd is fixed value " false ".

[1..1] [M] contentId (II) { "NPFIT-100007#Act" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance


The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID " 2.16.840.1.113883.2.1.3.2.4.18.16 "
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] seperatableInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

This attribute is used to indicate that the returned NHS111 reports can be interpreted separatley from the Repeat Caller Service outcome.

Implementation in XML Instance

The XML attribute seperatableInd is fixed to "true".

[1..1] nHS111ReportChoice (NHS111ReportChoice)
A link to the returned NHS111 reports.
NHS111ReportChoice
An abstract placeholder for the templates for the returned NHS111 Reports.
Used by: RepeatCallerResponse
[1..1] : Template3
RecipientChoice
An abstract placeholder for the choice of recipients.
Used by: RepeatCallerResponse
[1..1] : Template2
AuthorChoice
An abstract placeholder for the template choice for an author
Used by: RepeatCallerResponse
[1..1] : Template1
Request
Class to hold the identifier of the query to the Repeat Caller Service.
Used by: RepeatCallerResponse
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }
Model Attribute Description

The HL7 attribute classCode describes this class as a control act.

Implementation in XML Instance

The XML attribute classCode is fixed to " CACT".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode describes this class as an event.

Implementation in XML Instance

The XML attribute moodCode is fixed to " EVN".
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id holds the query identifier.

Implementation in XML Instance

The XML attribute id is populated with the DCE UUID of the query

  • The XML attribute root will hold the DCE UUID of the query
PermissionToViewChoice
An abstract placeholder for the templates for the permission to view outcome.
Used by: RepeatCallerResponse
[1..1] : Template4